[preview] Lock a vehicle.

Lock a vehicle. This requires a vehicle gateway with locking capabilities.

Rate limit: 100 requests/min (learn more about rate limits here).

To use this endpoint, select Write Vehicle Lock/Unlock under the Vehicles category when creating or editing an API token. Learn More.

Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should NOT rely on these APIs to build business critical applications

• Samsara may change the structure of a preview API’s interface without versioning or any notice to API users.

• When an endpoint becomes generally available, it will be announced in the API changelog.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

PUT /preview/fleet/vehicles/{id}/lock

[preview] Lock a vehicle.

cURL

curl --request PUT \
  --url https://api.samsara.com/preview/fleet/vehicles/{id}/lock \
  --header 'Authorization: Bearer <token>'

200

This response has no body data.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

The ID of the vehicle to lock or unlock. This can be a Samsara internal ID or an external ID in the format samsara.vin:{VIN}.

Response

200